Skip to content

Conversation

ThierryO
Copy link
Member

No description provided.

@ThierryO ThierryO requested a review from RCinbo May 21, 2025 14:48
@ThierryO ThierryO marked this pull request as ready for review May 21, 2025 14:48
Copy link
Member

@RCinbo RCinbo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mainly made some suggestions for the documentation fo the functions.
Testing the functions, I obtained the results that I was expecting. Looks good!

#' @inheritParams import_observations
#' @inheritParams unlikely_status
#' @param conn_reference a connection to the reference database.
#' @export
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#' @param alpha A numeric value between 0 and 1 indicating the family-wise Type
#' I error.
#' Default of 0.01.
#' @param max_dist A numeric value indicating the cluster distance in meters.
#' Default of 336

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#' @inheritParams unlikely_status

This includes the @param not documented in this function but documented in unlikely_status. Don't repeat yourself ;-)
Not documenting a function argument will result in a Rcmd_check() error.

#' @inheritParams sf::st_as_sf
#' @inheritParams sf::st_buffer
#' @inheritParams sf::st_concave_hull
#' @param relevant_area An `sf` object with the relevant area.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#' @param dist The size of the buffer (in meters) around each observation.
#' Default of 50.
#' @param crs The coordinate reference system for the observations and the relevant area.
#' Default of 31370 (Belgian Lambert 72).
#' @param ratio A numeric value which controls the concavity of the resulting hull around the observations
#' Default of 0.95

Co-authored-by: raisa_carmen <56317093+RCinbo@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants